home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / ab20 / ab20_archive / networking / arn-1.00-alpha3.lha / arnmaster.doc < prev    next >
Text File  |  1992-03-10  |  7KB  |  190 lines
  1.  
  2.                                ArnMaster.doc
  3.  
  4.           ArnMaster V0.8 - (C)opyright 1991-92 by Roland Bless
  5.  
  6.  
  7. 1. Copyright
  8.    ---------
  9.    See Arn.doc for copyright and distribution.
  10.  
  11. 2. Purpose
  12.    -------
  13.    ArnMaster creates (small) databases for Arn. These databases are
  14.    read by Arn and inform it about subject,author,lines,followups,etc.
  15.    To get fast and comfortable news-reading these databases are required.
  16.    Because of their clever design they are quite small and can be used
  17.    on systems with low disk space, too.
  18.  
  19. 3. .arnmasterrc
  20.    ------------
  21.    ArnMaster requires a configuration file, yet (maybe removed in
  22.    later versions). It's called ".arnmasterrc" and should be placed into
  23.    your UULIB: directory.
  24.    If you have .arnrc in your UULIB: you can use this instead and add
  25.    necessary entries there (.arnmaster should not exist then because it
  26.    has higher priority). Note that the former keyword NEWSDIRTYPE is no
  27.    longer valid in .arnrc!
  28.  
  29.    Currently there are only four entries required:
  30.  
  31.    ACTIVEFILE        where is your active-file and what's its name?
  32.    ~~~~~~~~~~
  33.  
  34.    ARNMASTERLOG      where should ArnMaster have its logfile?
  35.    ~~~~~~~~~~~~
  36.  
  37.    DOTDIRS           if your newsgroups-hierarchy is of the following form:
  38.    ~~~~~~~           comp.sys.amiga.programmers is stored in
  39.                      UUNEWS:comp.sys.amiga.programmers
  40.                      then this entry should exist!
  41.                      The other form is
  42.                      UUNEWS:comp/sys/amiga/programmers
  43.                      which is the default and the DOTDIRS keyword should
  44.                      be deleted from your config-file in this case.
  45.  
  46.    NEWSDIR           Specify the name of your newsgroups directory.
  47.    ~~~~~~~           If this entry is missing UUNEWS: is default.
  48.  
  49.    Example:
  50.  
  51.    ACTIVEFILE    UULIB:news/active
  52.    ARNMASTERLOG  T:logfile
  53.    DOTDIRS       Yes
  54.  
  55.  
  56. 3. Usage
  57.    -----
  58.    ArnMaster should be placed the directory where your other UUCP commands
  59.    feel comfortable (e.g. UUCP:c or UUCP:bin).
  60.    User of Dillon's AmigaUUCP _MUST_ specify the -A option (unless you
  61.    already have an active-file).
  62.  
  63.    ArnMaster can only be started from CLI:
  64.  
  65.    arnmaster [-idALCP(n)X] [-g|G groupname]
  66.  
  67.    Options:
  68.  
  69.    -i        Info about usage and version.
  70.  
  71.    -d        Debug. Some more information is printed during scanning on
  72.              standard-output (stdout).
  73.  
  74.    -P(n)     Set Task Priority to (n). Example: -P-2 sets the priority to
  75.              -2.
  76.  
  77.    -X        Deletes ALL databases.
  78.  
  79.    -g name   Scan only group name.
  80.  
  81.    -G dir    Scan only special directory and create .newsdb.
  82.              Normally Arn uses this option if it is directed to a
  83.              directory.
  84.  
  85.    -A        Scan all newsgroups and update your ACTIVEFILE.
  86.              IMPORTANT: This switch MUST be present if you use Dillon's
  87.              AmigaUUCP!!
  88.  
  89.    -L        Generates Lines: number in databases if missing in article
  90.              header. The original article header is untouched!
  91.              Because counting the lines will require some time this
  92.              option is NOT default. In later versions you can tell the
  93.              daemon (to be written) that this should be the default via an
  94.              ENV-variable.
  95.  
  96.    -C        Check for inconsistent databases.
  97.              This option forces Arnmaster to read all the databases
  98.              and to rescan articles if they are not in the database,
  99.              but in the active-range. Some articles are expired in
  100.              the active range or were cancelled, so it's legal that
  101.              they are missing in the database.
  102.              This option was introduced due to a bug in Arnmaster
  103.              which sometimes caused missing datasets in the databases.
  104.              THIS OPTION WILL MAKE YOUR DATABASES AS ACTUAL AS POSSIBLE.
  105.  
  106. 4. Action
  107.    ------
  108.    ArnMaster reads your activefile and compares it with the copy active.bak.
  109.    If there are differences the group is scanned.
  110.    [If you specified the -A option ArnMaster will scan all groups that it
  111.    found in ACTIVEFILE. If you don't have an ACTIVEFILE yet, you simply
  112.    should list ALL newsgroups you get in the ACTIVEFILE, one groupname per
  113.    line. You maybe can copy the "Newsgroups" file from AmigaUUCP to
  114.    ACTIVEFILE, if there are _no_ entries after the newsgroupname in a line.
  115.    Don't forget (although not required) to set the 'm' flag for moderated
  116.    groups, once ArnMaster 'created' the ACTIVEFILE, see Arn.doc for
  117.    active-file format.]
  118.  
  119.    First, the old database is read if it exists, discarding all expired
  120.    entries, then all new articles are scanned and the information is
  121.    written back into a new database.
  122.    The databases are created in the group directories with the name
  123.    .newsdb.
  124.    ArnMaster assumes that 0 is not a valid article-number.
  125.    If all groups are scanned, the current active file is copied under the
  126.    same name with the extension .bak.
  127.  
  128.    ** Note: Databases may contain false information if you delete articles
  129.             manually (esp. articles with highest numbers). New articles
  130.             get old subjects from deleted articles.
  131.             You can try the "-C" option first, but if this fails
  132.             delete all databases with "arnmaster -X" and the ACTIVEFILE.bak
  133.             copy, then invoke arnmaster once again and all databases should
  134.             be corrected.
  135.  
  136.             To have consistent databases it is recommended to start
  137.             arnmaster after each expire-run, too (best with -C)!!
  138.  
  139.    An ACTIVE-FILE is no longer required if you use the -A option.
  140.  
  141. 5. LOGFILE
  142.    -------
  143.    The main logfile entries look like this:
  144.    arnmasterV0.6 -(09 Feb 92 19:18:37)- group.name:      12/102:102
  145.  
  146.    The number before the slash are the articles that Arnmaster should have
  147.    scanned (in this example 12). This number is calculated from the
  148.    difference between ACTIVEFILE and ACTIVEFILE.bak. If there is a 0
  149.    it means that Arnmaster looked for expired entries.
  150.  
  151.    The next number shows how many articles Arnmaster actually has got in
  152.    its database. The number after the colon shows how many articles it
  153.    should be refering to the ACTIVEFILE. If these numbers are not the same
  154.    then you
  155.  
  156. 6. ERRORS
  157.    ------
  158.    You should report database errors to bugs@spirits.ka.sub.org, but only
  159.    if you send an lharced and uuencoded .newsdb with the concerning article
  160.    header. You can find out the article number and group in your LOGFILE.
  161.  
  162. 7. BUGS
  163.    ----
  164.    Sometimes you could get inconsistent databases.
  165.    You should check from time to time with -C option for those :-)
  166.  
  167. Version history:
  168. + new feature , - changed or bug fix
  169.  
  170.  
  171. 0.5 first release with alpha version 1.00 of Arn
  172.  
  173. 0.6 - Fixed bug in database reading, which sometimes caused a rejection of
  174.       articles which were not expired
  175.  
  176.     + Added -L option for counting lines in articles where the Lines:-
  177.       header-line is missing.
  178.  
  179.     + Added -C option for checking for and rebuilding inconsistent
  180.       databases.
  181.  
  182.     - Complete rescan if article-numbers in ACTIVEFILE.BAK are higher than
  183.       in ACTIVEFILE.
  184.  
  185. 0.7 - -i option didn't free all allocated memory.
  186.  
  187. 0.8 - bug removed that caused endless loops with "Re^" in subject.
  188.     - bug in finding realnames removed.
  189.  
  190.